Get Details for Specific Service (Live Platform Id)
The Get Details for Specific Service (Live Platform Id) request retrieves the details of a specific service using the Live Platform Id. Use this request to retrieve detailed information for the service.
URI
{{baseUrl}}api/ovoc/v1/topology/services/<id>HTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
<id> |
string |
Id of the Service in Live Platform portal. See Retrieve Live Platform Services. |
Example Response
Example of a response for a request without allDetails or allDetails=false in query string:
{
"elementsCount": {
"total": 2,
"devices": 0,
"links": 2,
"sites": 0
},
"lcCustomerId": 85844,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "ERROR",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [],
"licenseType": "PRO",
"serviceDeviceId": 7005,
"attachedLinks": [
98800,
97676
],
"serviceUcaasTenantId": "56056a77-07a5-43a7-bb1b-3d6f3c8e2b07",
"id": 97674,
"serviceId": "c18bbb60-eafb-4e6a-b1a1-518164fe3a55",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2026-01-18T15:28:48.844+0000",
"serviceSource": "OC",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "BradOC2",
"usersCount": 0,
"serviceName": "BradOC2",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/97674",
"lastBackupTime": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "BradOC2",
"tenantId": 1,
"parameters": [
{
"name": "METERING TAG",
"type": "String",
"value": ""
},
{
"name": "TOTAL DIDS",
"type": "Integer",
"value": 0
},
{
"name": "USED DIDS",
"type": "Integer",
"value": 0
},
{
"name": "UNUSED DIDS",
"type": "Integer",
"value": 0
},
{
"name": "USERS COUNT",
"type": "Integer",
"value": 0
},
{
"name": "ORDERED USERS",
"type": "Integer",
"value": 40
}
],
"status": "ERROR"
}HTTP Responses
| ■ | 200 OK |
This request retrieves data for all service types, parameters that are not applicable to Direct Routing and Operator Connect services are not included in the table.
|
Parameter |
Type |
Description |
|||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
elementsCount |
dictionary |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
total |
integer |
The total number of entities deployed for the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
links |
integer |
The total number of links deployed for the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
lcCustomerId |
long (1-max long) |
Id of the Live Platform customer. |
|||||||||||||||||||||||||||||||||||||||||||||
|
umpUsersSuspendAlarmStatus |
integer |
||||||||||||||||||||||||||||||||||||||||||||||
|
description |
string (0-100) |
Brief customer description |
|||||||||||||||||||||||||||||||||||||||||||||
|
type |
string |
Service |
|||||||||||||||||||||||||||||||||||||||||||||
|
applicationsStatus |
dictionary |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
management |
dictionary |
managementStatus |
|||||||||||||||||||||||||||||||||||||||||||||
|
managementStatus |
string |
Statuses for the Live Platform Portal Management entity:
|
|||||||||||||||||||||||||||||||||||||||||||||
|
voiceQuality |
dictionary |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
licenseType |
serviceLicenseType |
License type of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceDeviceId |
integer |
The Id of the SBC device attached to the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
attachedLinks |
array of attachments links IDs (Longs) |
List of Ids for attached SIP Connections. |
|||||||||||||||||||||||||||||||||||||||||||||
|
id |
long (node_id sequence) |
Id of the service |
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceId |
string (0-255) |
Live Platform internal service Id |
|||||||||||||||||||||||||||||||||||||||||||||
|
definedAt |
$date-time |
The date and time of the creation of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceSource |
serviceSourceType |
The type of service:
|
|||||||||||||||||||||||||||||||||||||||||||||
|
freeDIDs (Unused DIDS) |
integer (max int) |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
fullName |
string (0-250) |
Full name of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
usersCount |
integer (max int) |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceName |
string (0-100) |
The name of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
umpUsersCount |
integer (max int) |
The number of used DIDs for Direct Routing and Operator Connect customers. |
|||||||||||||||||||||||||||||||||||||||||||||
|
url |
path |
The Rest URL for performing actions on the service. /ovoc/v1/topology/services/<serviceid> |
|||||||||||||||||||||||||||||||||||||||||||||
|
usedDIDs |
integer (max int) |
M365 user properties including phone number assignment is not supported for Hosted Essentials services.
|
|||||||||||||||||||||||||||||||||||||||||||||
|
Enabled |
boolean |
Indicates whether the Live Platform license is enabled for the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
totalDIDs |
integer (max int) |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
umpId (CustomerGuid) |
string ($uuid) |
The umpCustomerGuid created in the Live Platformcustomer tenant SQL database :
This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created. |
|||||||||||||||||||||||||||||||||||||||||||||
|
name |
string |
The name of the service (identical value to "serviceName"). |
|||||||||||||||||||||||||||||||||||||||||||||
|
tenantId |
long (1-max long) |
The Microsoft Entra Tenant Id of the Service Provider. |
|||||||||||||||||||||||||||||||||||||||||||||
|
parameters (Direct Routing custom parameters) |
list array |
This array includes the following parameters:
|
|||||||||||||||||||||||||||||||||||||||||||||
|
Ordered Users |
string |
The Acquired Licenses for the Direct Routing and Operator Connect services that are configured when the service is onboarded. |
|||||||||||||||||||||||||||||||||||||||||||||
|
CAC Profile |
string |
CAC Profile value, for example "8 sessions" | |||||||||||||||||||||||||||||||||||||||||||||
|
Carrier Id |
string |
Carrier Id (SBC Proxy Set), for example
|
|||||||||||||||||||||||||||||||||||||||||||||
|
status |
string |
Management status of the customer:
|
| ■ | 400: Bad Request (e.g., empty request body) |
| ■ | 404: Resource not found or belongs to a different tenant |
| ■ | 409: Conflict when tenant ID validation fails |
| ■ | 500: Internal server error or communication error with Live Platform portal |
| ■ | 503: Service Unavailable when Live Platform portal is not configured |